-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for downloading and using VS Code #197
Add documentation for downloading and using VS Code #197
Conversation
docs/VSCODE_DEVELOPMENT.md
Outdated
|
||
[Visual Studio Code](https://code.visualstudio.com/) is a great and simple IDE that can be used to build & develop with for CHIP. | ||
|
||
CHIP supports the docker / remote container workflow that Visual Studio Code, and has an container environment setup automatically. You can read more about this workflow [here](https://code.visualstudio.com/docs/remote/containers). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be missing a word or two after "that...".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also "...a container...".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few typos to address; otherwise, looks good.
* Documentation about style is documented in [the style guide](./STYLE_GUIDE.md) | ||
* Additional documentation about more specific files are in the [style folder](./style/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: this might just be a bit of OCD on my part, but you have 2 links defined here and one includes the the
and the other doesn't. Recommend removing the the
as that appear to fall inline with the rest of the document.
1. Install [Visual Studio Code](https://code.visualstudio.com/) for your operating system of choice here: <https://code.visualstudio.com/Download> | ||
1. Install [Git](https://git-scm.com/) if you haven't already | ||
1. Git clone the main CHIP repository here: <https://github.com/project-chip/connectedhomeip> | ||
1. Launch Visual Studio Code, and open the cloned folder from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: remove the from
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting this together 🙌
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
… Matter Spec 1.0 Merge in WMN_TOOLS/matter from feature/unify-matter-bridge-alpha2-updates to silabs_1.0 Squashed commit of the following: commit f681fff382c1b8435f4722e27be7b4c85ec6f874 Author: Jakob Olesen <[email protected]> Date: Thu Oct 20 10:47:15 2022 +0200 Fixed ColorTemperature light support commit b25a0bfd8c688ef547f5f2a1a8b1db549c31a1ed Author: Thomas Bowley <[email protected]> Date: Wed Oct 19 15:53:11 2022 +0200 NoJira: Log JSON parse or type errors as warnings and not infos. commit 336412ce0361764eff20c565f888714a5cc8cee3 Author: Dennis Jensen <[email protected]> Date: Wed Oct 19 14:04:50 2022 +0200 NoJira: Don't map endpoints with only 'Groups' or 'NameAndLocation' clusters in them. ... and 2 more commits
… with latest Matter Spec 1.0 Merge in WMN_TOOLS/matter from feature/unify-matter-bridge-alpha2-updates to silabs_1.0 Squashed commit of the following: commit f681fff382c1b8435f4722e27be7b4c85ec6f874 Author: Jakob Olesen <[email protected]> Date: Thu Oct 20 10:47:15 2022 +0200 Fixed ColorTemperature light support commit b25a0bfd8c688ef547f5f2a1a8b1db549c31a1ed Author: Thomas Bowley <[email protected]> Date: Wed Oct 19 15:53:11 2022 +0200 NoJira: Log JSON parse or type errors as warnings and not infos. commit 336412ce0361764eff20c565f888714a5cc8cee3 Author: Dennis Jensen <[email protected]> Date: Wed Oct 19 14:04:50 2022 +0200 NoJira: Don't map endpoints with only 'Groups' or 'NameAndLocation' clusters in them. ... and 2 more commits
Problem
We should have some base common instructions for setting up VS Code & Local Builds
Summary of Changes
Documentation updates, aligning tasks with it
#186